is-arguments

What is is-arguments?

The is-arguments npm package is designed to check if a given value is an arguments object. This can be particularly useful in functions where you need to differentiate between an array and the arguments object, or when trying to ensure compatibility across different JavaScript environments where the typeof operator might not suffice.

What are is-arguments's main functionalities?

Check if a value is an arguments object

This feature allows you to check if a given value is an arguments object. It's particularly useful in scenarios where you need to distinguish between an array and the arguments object passed to a function.

const isArguments = require('is-arguments');

function example() {
  console.log(isArguments(arguments)); // true
  console.log(isArguments([1, 2, 3])); // false
}

example();

Other packages similar to is-arguments

isarray

Similar to is-arguments, isarray checks if a given value is an array. While is-arguments focuses on identifying arguments objects, isarray focuses on arrays. Both packages serve to identify specific data structures, making them useful in different but somewhat related scenarios.

lodash.isarguments

Part of the Lodash library, lodash.isarguments provides a similar functionality to is-arguments by checking if a value is an arguments object. The main difference is that lodash.isarguments comes as part of the larger Lodash utility library, which offers a wide range of functions for different types of data manipulation and checking.

README

is-arguments

Is this an arguments object? It's a harder question than you think.

Example

var isArguments = require('is-arguments');
var assert = require('assert');

assert.equal(isArguments({}), false);
assert.equal(isArguments([]), false);
(function () {
	assert.equal(isArguments(arguments), true);
}())

Caveats

If you have modified an actual arguments object by giving it a Symbol.toStringTag property, then this package will return false.

Tests

Simply clone the repo, npm install, and run npm test

Changelog

v1.1.1 - 2021-08-05

Commits

• [actions] use node/install instead of node/run; use codecov action dd28b30
• [meta] do not publish github action workflow files 87e489c
• [readme] fix repo URLs e2c2c6e
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, tape b9ae62b
• [readme] add github actions/codecov badges 504c0a5
• [Fix] use has-tostringtag to behave correctly in the presence of symbol shams dc29e52
• [Dev Deps] update auto-changelog, eslint, tape a966d25
• [Dev Deps] update eslint, @ljharb/eslint-config, tape 1218944
• [meta] use prepublishOnly script for npm 7+ 757dbee
• [Deps] update call-bind b206f05
• [actions] update workflows b89b2f1